home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / Xpm / lib / xpm-3.2g / CHANGES next >
Text File  |  1994-08-01  |  20KB  |  512 lines
  1. /* Copyright 1990-93 GROUPE BULL -- See license conditions in file COPYRIGHT */
  2. /**************************************************************************\
  3. *                                        *
  4. *              HISTORY of user-visible changes               *
  5. *                                        *
  6. \**************************************************************************/
  7.  
  8. 3.2g    (93/04/26)
  9.  
  10.     ENHANCEMENTS:
  11.     - much faster close colors
  12.     - piping from/to compressed files now handles GNU's gzip (.z)  format
  13.     - added XpmColorKey attribute - ability to specify which visual's
  14.       colors to use (ie: now it's possible to read in a pixmap in a
  15.       color visual, but use the colors specified for monochrome).
  16.     - added -mono, -grey4, -grey and -color options to sxpm to demonstrate
  17.       the XpmColorKey attribute.
  18.         - Jason Patterson <jasonp@fitmail.qut.edu.au>
  19.  
  20.     BUGS CORRECTED:
  21.     - fixed bug where redefining "None" as a pixel stopped mask generation
  22.     - minor SVR4 defines for <string.h>
  23.     - fixed annoying closecolor bug related to read/write color cells
  24.     - fixed minor bug in color value -> pixel overloading
  25.     - manual updated to include new red/green/blue closeness attributes
  26.         - Jason Patterson <jasonp@fitmail.qut.edu.au>
  27.  
  28.     - the top Imakefile was missing the depend target
  29.     - sxpm/Imakefile fixed so that -L../lib is set before the standard
  30.       library location.
  31.         - Vivek Khera <khera@cs.duke.edu>
  32.  
  33.     - lib/xpmP.h now defines bcopy as memcpy for VMS (required by recent
  34.       versions of VMS)
  35.         - J. Daniel Smith <dsmith@ann-arbor.applicon.slb.com>
  36.  
  37.     - the lib/Imakefile didn't work with X11R4.
  38.  
  39.  
  40. 3.2f        (93/03/17)
  41.  
  42.     NEW FEATURES:
  43.     - the library provides four new functions to deal with Xpm files
  44.       loaded in memory as single character strings buffers:
  45.  
  46.             XpmCreateImageFromBuffer
  47.             XpmCreatePixmapFromBuffer
  48.             XpmCreateBufferFromImage
  49.             XpmCreateBufferFromPixmap
  50.  
  51.     - in addition, as a convenience, two functions are provided to copy a
  52.       file in a buffer and to write a file from a buffer:
  53.  
  54.             XpmReadFileToBuffer
  55.             XpmWriteFileFromBuffer
  56.  
  57.     ENHANCEMENTS:
  58.     - Files are now dispatched in the following sub-directories:
  59.       lib, sxpm, and doc.
  60.     - Imakefiles will let you build a shared library as well as the static
  61.       one (with either X11R4 or X11R5).
  62.     - The documentation has been ported from LaTeX to FrameMaker and is
  63.       now included in the distribution in its PostScript form (doc/xpm.ps).
  64.       Source files are available on request.
  65.       Also the documentation has been reoreganized and includes a table of
  66.       contents and an index of the functions (the number of functions
  67.       increasing this became a requisite).
  68.  
  69.     BUGS CORRECTED:
  70.     - Many warnings have been fixed - patch from Daniel Dardailler 
  71.       daniel@osf.org
  72.  
  73. 3.2e        (93/02/05)
  74.  
  75.     ENHANCEMENTS:
  76.     - use XpmMalloc, XpmRealloc, XpmCalloc, and XpmFree which are defines
  77.     in xpmP.h. This should help people wanting to use their own functions.
  78.  
  79.     BUGS CORRECTED:
  80.     - Intrinsic.h is no longer included.
  81.     - bzero is defined as memset on SYSV and SVR4.
  82.     - some memory initialisation bug concerning XpmAttributes.
  83.  
  84. 3.2d        (93/01/27)
  85.  
  86.     ENHANCEMENTS:
  87.         - compile on Solaris 2.0
  88.         - patch from Clint Jeffery <cjeffery@cs.arizona.edu>
  89.  
  90.     BUGS CORRECTED:
  91.     - shape masks are now set correctly for LSBFirst (Decs).
  92.     - pixmaps are now set correctly for 2 bit displays (Nexts).
  93.         - patch from Josef Leherbauer <joe@takeFive.co.at>
  94.     - isspace was called on getc which fails when EOF is returned.
  95.         - Marelli Paolo <marelli@colos3.usr.dsi.unimi.it>
  96.  
  97. 3.2c        (92/12/29)
  98.  
  99.     ENHANCEMENTS:
  100.         - parsing optimized for single and double characters color
  101.         - patch originally from Martin Brunecky 
  102.                        marbru@build1.auto-trol.com
  103.  
  104.     BUGS CORRECTED:
  105.     - XpmFreeExtensions was calling free on some argument without checking
  106.     it was not NULL.
  107.     - strdup was not correctly defined for systems which do not provide
  108.     it.    - Hans-Peter Lichtin <lich@zellweger.ch>
  109.     - some bug in XpmCrDataFI.c
  110.             - Sven Delmas garfield@avalanche.cs.tu-berlin.de
  111.  
  112.     NOTE:
  113.         - there is still a bug with the creation of the clipmask on display of
  114.     depth 2 but I can't find a fix because unfortunately I don't have such
  115.     a rendering system and nobody gets the time to investigate for me.
  116.  
  117. 3.2b        (92/10/19)
  118.  
  119.     ENHANCEMENTS:
  120.     - Create XpmReadFileToData and XpmWriteFileFromData
  121.         - Dan Greening <dgreen@sti.com>
  122.         - added "close colors" support and ability to redefine color values
  123.       as pixels at load time, as well as color names
  124.         - Jason Patterson <jasonp@fitmail.qut.edu.au>
  125.     - errors while parsing or allocating colors now revert to other
  126.       visual defaults, creating pixmap/image as expected, and returning
  127.       XpmSuccess. The old behaviour of XpmColorError being returned and no
  128.       pixmap/image being created can be retained by setting the
  129.       exactColors attribute.
  130.         - Jason Patterson <jasonp@fitmail.qut.edu.au>
  131.  
  132.     BUGS CORRECTED:
  133.     - SVR4 defines for including <string.h> instead of <strings.h>
  134.         - Jason Patterson <jasonp@fitmail.qut.edu.au>
  135.     - attributes->extensions and attributes->nextensions fields were not 
  136.       set correctly when no extensions present in file.
  137.         - Simon_Scott Cornish <cornish@ecr.mu.oz.au>
  138.  
  139. 3.2a        (92/08/17)
  140.  
  141.     ENHANCEMENTS:
  142.         - use the mock lisp hashing function instead of the gnu emacs one,
  143.     it is faster in some cases and never slower (I've not found any case).
  144.  
  145.     BUGS CORRECTED:
  146.     - function prototypes for ansi compilers.
  147.     - some memory initialization bugs (purify is just great for this).
  148.     - empty strings in extensions are now correctly handled.
  149.  
  150. 3.2        (92/07/06)
  151.  
  152.     NEW FEATURES:
  153.     - both format and functions handle extensions data. This allow people
  154.     to store additional data related to a pixmap. See documentation for
  155.     detail.
  156.     - sxpm supports the new option '-c' to use a private colormap. This is
  157.     useful when displaying pixmaps using a lot of colors.
  158.     - sxpm supports the new option '-v' (verbose) to get possible
  159.     extensions print out on standard error.
  160.  
  161.     ENHANCEMENTS:
  162.         - most of the code has been reworked to be improved and thus almost
  163.     every function is faster. It takes less than 6 seconds of real time on
  164.     a sun4 to display, with sxpm, a 487x635 pixmap using 213 colors, while
  165.     it takes 32 seconds with the old library! It takes 18 seconds to
  166.     display a 1279x1023 screen dump using 14 colors while xwud takes 10
  167.     seconds.
  168.     Of course performance improvements are not always that great, they
  169.     depend on the size and number of colors but I'm sure everybody will
  170.     appreciate ;-)
  171.     I know how to improve it more but this will require changes in the
  172.     architecture so this is not for now. Some optimizations have been
  173.     contributed by gregor@kafka.saic.com (gregg hanna) and
  174.     jnc@csl.biosci.arizona.edu (John N. Calley).
  175.     - the Imakefile is modified to let you install sxpm - Rainer Klute
  176.            <klute@irb.informatik.uni-dortmund.de>
  177.     - xpmP.h declares popen for Sequent platforms - Clinton Jeffery
  178.        <cjeffery@cs.arizona.edu>
  179.     - XpmWriteFileFromImage/Pixmap rather than truncating the pixmap name
  180.     to the first dot changes dots to underscores to get a valid C syntax
  181.     name.
  182.  
  183.  
  184.     BUGS CORRECTED:
  185.     - there was a bug in the image creation function for some 24 bits
  186.     displays. It is fixed.
  187.     - allocated color pixels are now freed when an error occurs -
  188.        nusser@dec1.wu-wien.ac.at (Stefan Nusser)
  189.  
  190.     CHANGES TO THE DOC:
  191.     - the documentation describes the new XpmExtension structure and how
  192.     to use it with read and write functions.
  193.  
  194. 3.1        (92/02/03)
  195.  
  196.     ENHANCEMENTS:
  197.         - sxpm now have more standard options (mainly suggested by 
  198.     Rainer Sinkwitz <sinkwitz@ifi.unizh.ch>):
  199.  
  200.     Usage:  sxpm [options...]
  201.     Where options are:
  202.  
  203.     [-d host:display]            Display to connect to.
  204.     [-g geom]                    Geometry of window.
  205.     [-hints]                     Set ResizeInc for window.
  206.     [-icon filename]             Set pixmap for iconWindow.
  207.     [-s symbol_name color_name]  Overwrite color defaults.
  208.     [-p symbol_name pixel_value] Overwrite color defaults.
  209.     [-plaid]                     Read the included plaid pixmap.
  210.     [filename]                   Read from file 'filename', and from
  211.                      standard input if 'filename' is '-'.
  212.     [-o filename]                Write to file 'filename', and to standard
  213.                      output if 'filename' is '-'.
  214.     [-nod]                       Don't display in window.
  215.     [-rgb filename]              Search color names in the rgb text file
  216.                      'filename'.
  217.  
  218.     if no input is specified sxpm reads from stdandard input.
  219.  
  220.  
  221.     - Xpm functions and Ppm converters now deal with multiword colornames.
  222.       patches from Rainer Sinkwitz <sinkwitz@ifi.unizh.ch>.
  223.  
  224.  
  225. 3.0        (91/10/03)
  226.  
  227.     Functions name and defines have been modified again (sorry for that)
  228.     as follows:
  229.  
  230.          XpmReadPixmapFile    XpmReadFileToPixmap
  231.          XpmWritePixmapFile   XpmWriteFileFromPixmap
  232.  
  233.          XpmPixmapColorError  XpmColorError
  234.          XpmPixmapSuccess     XpmSuccess
  235.          XpmPixmapOpenFailed  XpmOpenFailed
  236.          XpmPixmapFileInvalid XpmFileInvalid
  237.          XpmPixmapNoMemory    XpmNoMemory
  238.          XpmPixmapColorFailed XpmColorFailed
  239.  
  240.     To update code using Xpm you can use the included shell script called
  241.     rename with the sed commands files name-3.0b-3.0c and name-3.0c-3.0.
  242.     Old names still valid though.
  243.  
  244.     NEW FEATURES:
  245.     - four new functions to work with images instead of pixmaps:
  246.  
  247.          XpmReadFileToImage
  248.          XpmWriteFileFromImage
  249.          XpmCreateImageFromData
  250.          XpmCreateDataFromImage
  251.  
  252.     ENHANCEMENTS:
  253.         Algorithms to create and scan images and pixmaps are based on the
  254.     MIT's R5 code, thus they are much cleaner than old ones and should
  255.     avoid any problem with any visual (yes, I trust MIT folks :-)
  256.  
  257.     BUGS CORRECTED:
  258.     Imakefile use INCDIR instead of ROOTDIR.
  259.  
  260.     CHANGES TO THE DOC:
  261.     - the documentation presents the four new functions.
  262.  
  263. 3.0c        (91/09/18)
  264.  
  265.     In answer to request of people functions, types and defines names have
  266.     been changed as follows:
  267.  
  268.          XCreatePixmapFromData     XpmCreatePixmapFromData
  269.          XCreateDataFromPixmap     XpmCreateDataFromPixmap
  270.          XReadPixmapFile         XpmReadPixmapFile
  271.          XWritePixmapFile         XpmWritePixmapFile
  272.          XFreeXpmAttributes         XpmFreeAttributes
  273.  
  274.          PixmapColorError         XpmPixmapColorError
  275.          PixmapSuccess         XpmPixmapSuccess
  276.          PixmapOpenFailed         XpmPixmapOpenFailed
  277.          PixmapFileInvalid         XpmPixmapFileInvalid
  278.          PixmapNoMemory         XpmPixmapNoMemory
  279.          PixmapColorFailed         XpmPixmapColorFailed
  280.  
  281.          ColorSymbol         XpmColorSymbol
  282.  
  283.     Generally speaking every public name begins with 'Xpm' and every
  284.     private one with 'xpm'. This should avoid any possible conflict.
  285.  
  286.     Some files have also be renamed accordingly.
  287.  
  288.     NEW FEATURES:
  289.     - support for VMS and two new options for sxpm: icon and hints (see
  290.     manual for details) Richard Hess <rhess%pleione%cimshop@uunet.UU.NET>
  291.     - DEFINES in Imakefile and Makefile.noXtree allows you to set the
  292.     following:
  293.  
  294.              ZPIPE for un/compressing piped feature (default is on)
  295.          NEED_STRCASECMP for system which doesn't provide one (default
  296.                  is off)
  297.  
  298.     - xpmtoppm.c has is own strstr function which is used if NEED_STRSTR
  299.     is defined when compiling - Hugues.Leroy@irisa.fr (Hugues Leroy).
  300.     
  301.     BUGS CORRECTED:
  302.     - many bugs have been fixed, especially for ansi compilers -
  303.            Doyle C. Davidson (doyle@doyled.b23b.ingr.com) and
  304.            Clifford D. Morrison (cdm%bigdaddy%edsr@uunet.UU.NET)
  305.     - parser is again a little more improved
  306.  
  307. 3.0b        (91/09/12)
  308.  
  309.     This is a complete new version with a new API and where files and
  310.     structures have been renamed. So this should be taken as a new
  311.     starting release.
  312.     This release should be quickly followed by the 3.0 because I'm planning
  313.     to send it for X11R5 contrib which ends October 5th.
  314.  
  315.     NEW FEATURES:
  316.     - support for transparent color.
  317.     - support for hotspot.
  318.     - a new function: XCreateDataFromPixmap to create an XPM data from a
  319.     pixmap in order to be able to create a new pixmap from this data using
  320.     the XCreatePixmapFromData function later on.
  321.     - a new structure: XpmAttributes which replace the XpmInfo structure
  322.     and which leads to a much simpler API with less arguments.
  323.     - arguments such as visual, colormap and depth are optionnal, default
  324.     values are taken if omitted.
  325.     - parsing and allocating color failures don't simply break anymore. If
  326.     another default color can be found it is used and a PixmapColorError
  327.     is returned. In case no color can be found then it breaks and returns
  328.     PixmapColorFailed.
  329.     - for this reason the ErrorStatus codes are redefined as follows:
  330.  
  331.            null     if full success
  332.            positive if partial success
  333.            negative if failure
  334.  
  335.     with:
  336.         #define PixmapColorError    1
  337.         #define PixmapSuccess       0
  338.         #define PixmapOpenFailed   -1
  339.         #define PixmapFileInvalid  -2
  340.         #define PixmapNoMemory     -3
  341.         #define PixmapColorFailed  -4
  342.  
  343.     - sxpm prints out a warning when a requested color could not be parsed
  344.     or alloc'ed, and an error when none has been found.
  345.     - sxpm handles pixmap with transparent color. For this purpose the
  346.     plaid_mask.xpm is added to the distribution.
  347.  
  348.     BUGS CORRECTED:
  349.     - I've again improved the memory management.
  350.     - the parser is also improved.
  351.     - when writting a pixmap to a file the variable name could be
  352.     "plaid.xpm" which is not valid in C. Now the extension name is cut off
  353.     to give "plaid" as variable name.
  354.     - reading multiple words colornames such as "peach puff" where leading
  355.     to non readable Xpm files. They are now skipped to have only single
  356.     word colorname. Lionel Mallet (mallet@ipvpel.unipv.it).
  357.     - parser was triggered by the "/" character inside string.
  358.     Doyle C. Davidson (doyle@doyled.b23b.ingr.com). This is corrected.
  359.     - sxpm maps the window only if the option "-nod" is not selected. 
  360.  
  361.     CHANGES TO THE DOC:
  362.     - the documentation presents the new API and features.
  363.  
  364. 3.0a        (91/04/10)
  365.  
  366.     This is an alpha version because it supports the new version of XPM,
  367.     but the library interface is still the same. Indeed it will change in
  368.     future release to get rid of obsolete stuff such as the type argument
  369.     of the XWritePixmapFile function.
  370.  
  371.     ******************************* WARNING *********************************
  372.     The format is not anymore XPM2, it is XPM version 3 which is XPM2
  373.     limited to the C syntax with the key word "XPM" in place of "XPM2 C".
  374.     The interface library has not changed yet but the type argument of
  375.     XWritePixmapFile and the type member of XpmInfo are not used anymore.
  376.     Meanwhile the library which is now called libXpm.a is backward
  377.     compatible as XPM2 files can be read. But the XWritePixmapFile
  378.     function only writes out XPM version 3 files.
  379.     *************************************************************************
  380.  
  381.     NEW FEATURES:
  382.     - the library doesn't use global variables anymore, thus it should be
  383.     able to share it.
  384.     - sxpm has been rewritten on top of Xt, it can be used to convert
  385.     files from XPM2 to XPM version 3.
  386.     - xpm1to2c.perl has been upgraded to the new XPM version and renamed
  387.     as xpm1to3.perl
  388.     - ppmtoxpm2.c and ppmtoxpm2.1 have been upgraded too and renamed
  389.     ppmtoxpm.c and ppmtoxpm.1. In addition the xpmtoppm.c and xpmtoppm.1
  390.     of the pbmplus package have been upgraded too. xpmtoppm can thus
  391.     convert XPM version 1 and 3 to a portable pixmap. These files should
  392.     replace the original ones which are part of the pbmplus package. See
  393.     the ppm.README file for more details.
  394.     - the library contains RCS variables which allows you to get revision
  395.     numbers with ident (which is part of the RCS package). The Id number
  396.     is an internal rcs number for my eyes only. The official one is found
  397.     in Version.
  398.  
  399.     BUGS CORRECTED:
  400.     - the memory management has been much improved in order to avoid
  401.     memory leaks.
  402.     - the XImage building algorythm has been changed to support correctly
  403.     different visual depths. There is special code to handle depths 1, 4,
  404.     6, 8, 24, and 32 to build the image and send it in one whack, and
  405.     other depths are supported by building the image with XPutPixel which
  406.     is slow but sure.
  407.     - similar algorithms are used to read pixmaps and write them out.
  408.  
  409.     CHANGES TO THE DOC:
  410.     - the documentation presents the new XPM format.
  411.  
  412.  
  413. 2.8        (90/12/19)
  414.  
  415.     ******************************* WARNING *********************************
  416.         Since the last release two structures have been modified and have now
  417.     bigger sizes, so ANY CODE USING THE libXPM2 NEEDS TO BE RECOMPILED.
  418.     *************************************************************************
  419.  
  420.     NEW FEATURES:
  421.     - the ColorSymbol struct contains the new member 'pixel' which allow
  422.     to override default colors by giving a pixel value (in such a case
  423.     symbol value must be set to NULL),
  424.     - the XpmInfo struct contains the new member 'rgb_fname' in which one
  425.     can specify an rgb text file name while writing a pixmap with the 
  426.     XWritePixmapFile function (otherwise this member should be set to
  427.     NULL). This way colorname will be searched and written out if found
  428.     instead of the RGB value,
  429.     - Imakefile originally provided by stolcke@ICSI.Berkeley.EDU,
  430.     - the old Makefile is now distributed as Makefile.noXtree and presents
  431.     install targets,
  432.     - the demo application is renamed sxpm (Show XPM), creates a window of
  433.     the size of the pixmap if no geometry is specified, prints out
  434.     messages instead of status when an error occurs, handles the new
  435.     option -p for overriding colors by giving a pixel value (not really
  436.     useful but is just here to show this new feature), handles the new
  437.     option -rgb for specifying an rgb text file, and ends on
  438.     keypress as buttonpress,
  439.     - defines for SYSV have been provided by Paul Breslaw
  440.     <paul@mecazh.uucp>,
  441.     - the distribution includes a new directory called converters which
  442.     contains xpm1to2 and xpm1to2c perl converters and a ppmtoxpm2
  443.     converter provided by Paul Breslaw who upgraded the original ppmtoxpm
  444.     written by Mark W. Snitily <mark@zok.uucp>.
  445.  
  446.     CHANGES TO THE DOC:
  447.     - this file is created and will give old users a quick reference to
  448.     changes made from one release to the next one,
  449.     - documentation is changed to present the new ColorSymbol structure
  450.     and the way to override colors by giving a pixel value, and to present
  451.     the new XpmInfo structure and how to use it,
  452.     - a man page for sxpm is added to the distrib,
  453.     - the README file talks about sxpm and no more demo, and have
  454.     reference to the different converters.
  455.  
  456. 2.7        (90/11/12)
  457.  
  458.     NEW FEATURES:
  459.     - XReadPixmapFile reads from stdin if filename is NULL,
  460.     - XWritePixmapFile writes to stdin if filename is NULL,
  461.     - the demo application handles the new option -nod for no displaying
  462.     the pixmap in a window (useful when used as converter).
  463.  
  464.     CHANGES TO THE DOC:
  465.     - documentation about the new feature.
  466.  
  467. 2.6        (90/10/29)
  468.  
  469.     NEW FEATURES:
  470.     - from nazgul@alphalpha.com (Kee Hinckley): changes to make the
  471.     library usable as C++ code, and on Apollo without any warning.
  472.  
  473.     BUGS CORRECTED:
  474.     - from nazgul@alphalpha.com (Kee Hinckley): the xpm include files was
  475.     declaring XWritePixmapFile as taking in arg a Pixmap pointer instead
  476.     of a Pixmap.
  477.  
  478. 2.5        (90/10/17)
  479.  
  480.     BUGS CORRECTED:
  481.     - XWritePixmapFile was not closing the file while ending normaly.
  482.  
  483. 2.4        (90/09/06)
  484.  
  485.     NEW FEATURES:
  486.     - XReadPixmapFile reads from a piped uncompress if the given filename
  487.     ends by .Z or if filename.Z exists,
  488.     - XWritePixmapFile writes to a piped compress if the given filename
  489.     ends by .Z.
  490.  
  491.     BUGS CORRECTED:
  492.     - demo now deals with window manager.
  493.  
  494.     CHANGES TO THE DOC:
  495.     - documentation about compressed files management.
  496.  
  497. 2.3        (90/08/30)
  498.  
  499.     BUGS CORRECTED:
  500.     - handle monochrom display correctly,
  501.     - comments can be empty.
  502.  
  503. 2.2        (90/08/27)
  504.  
  505.     BUGS CORRECTED:
  506.     - when reading some invalid free was dumping core on some machine.
  507.  
  508. 2.1        (90/08/24)
  509.  
  510.     First distribution of XPM2.
  511.  
  512.